Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Direct PR][release-21.0] Add RPC changes segment in the summary doc #17034

Merged
merged 2 commits into from
Dec 2, 2024
Merged

[Direct PR][release-21.0] Add RPC changes segment in the summary doc #17034

merged 2 commits into from
Dec 2, 2024

Conversation

GuptaManan100
Copy link
Member

@GuptaManan100 GuptaManan100 commented Oct 22, 2024 •
edited
Loading

Description

We think it's a good idea to also include a segment that just talks about the changes made to RPC calls in the release. This will help users see at a glance what RPCs have changed across different versions.

Diff of all services/proto changes b/w v20 and v21: https://gist.github.com/rohit-nayak-ps/ff70493906f84094e66f92262f9be842

Related Issue(s)

Checklist

  • "Backport to:" labels have been added if this change should be back-ported to release branches
  • If this change is to be back-ported to previous releases, a justification is included in the PR description
  • Tests were added or are not required
  • Did the new or modified tests pass consistently locally and on CI?
  • Documentation was added or is not required

Deployment Notes

@vitess-bot vitess-bot
Copy link
Contributor

vitess-bot bot commented Oct 22, 2024

Review Checklist

Hello reviewers! 👋 Please follow this checklist when reviewing this Pull Request.

General

  • Ensure that the Pull Request has a descriptive title.
  • Ensure there is a link to an issue (except for internal cleanup and flaky test fixes), new features should have an RFC that documents use cases and test cases.

Tests

  • Bug fixes should have at least one unit or end-to-end test, enhancement and new features should have a sufficient number of tests.

Documentation

  • Apply the release notes (needs details) label if users need to know about this change.
  • New features should be documented.
  • There should be some code comments as to why things are implemented the way they are.
  • There should be a comment at the top of each new or modified test to explain what the test does.

New flags

  • Is this flag really necessary?
  • Flag names must be clear and intuitive, use dashes (-), and have a clear help text.

If a workflow is added or modified:

  • Each item in Jobs should be named in order to mark it as required.
  • If the workflow needs to be marked as required, the maintainer team must be notified.

Backward compatibility

  • Protobuf changes should be wire-compatible.
  • Changes to _vt tables and RPCs need to be backward compatible.
  • RPC changes should be compatible with vitess-operator
  • If a flag is removed, then it should also be removed from vitess-operator and arewefastyet, if used there.
  • vtctl command output order should be stable and awk-able.

@vitess-bot vitess-bot bot added NeedsBackportReason If backport labels have been applied to a PR, a justification is required NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsIssue A linked issue is missing for this Pull Request NeedsWebsiteDocsUpdate What it says labels Oct 22, 2024
@GuptaManan100 GuptaManan100 removed NeedsDescriptionUpdate The description is not clear or comprehensive enough, and needs work NeedsWebsiteDocsUpdate What it says NeedsIssue A linked issue is missing for this Pull Request NeedsBackportReason If backport labels have been applied to a PR, a justification is required labels Oct 22, 2024
@github-actions github-actions bot added this to the v21.0.0 milestone Oct 22, 2024
@GuptaManan100 GuptaManan100 changed the title [Direct PR][release-21] Add RPC changes segment in the summary doc [Direct PR][release-21.0] Add RPC changes segment in the summary doc Oct 22, 2024
@vitess-bot vitess-bot mentioned this pull request Oct 21, 2024
Closed
28 tasks
@rohit-nayak-ps
Copy link
Contributor

Here are the changes generated by the script given below

https://gist.github.com/rohit-nayak-ps/ff70493906f84094e66f92262f9be842

git checkout v20.0.0
cp -r proto /tmp/proto20
git checkout v21.0.0-rc2
cp -r proto /tmp/proto21
diff /tmp/proto2* > proto.diff

@vitess-bot vitess-bot mentioned this pull request Oct 28, 2024
Closed
40 tasks
@vitess-bot vitess-bot modified the milestones: v21.0.0, v21.0.1 Oct 29, 2024
@rohit-nayak-ps rohit-nayak-ps mentioned this pull request Oct 29, 2024
Closed
57 tasks
@rohit-nayak-ps
Copy link
Contributor

Moving to draft while we collect all the changes that we want to add.

@rohit-nayak-ps rohit-nayak-ps marked this pull request as draft October 29, 2024 12:51
@codecov Codecov
Copy link

codecov bot commented Oct 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 67.22%. Comparing base (e6ec0ba) to head (84a2e10).
Report is 17 commits behind head on release-21.0.

Additional details and impacted files 
@@               Coverage Diff                @@
##           release-21.0   #17034      +/-   ##
================================================
- Coverage         67.23%   67.22%   -0.02%     
================================================
  Files              1570     1570              
  Lines            251247   251279      +32     
================================================
- Hits             168938   168926      -12     
- Misses            82309    82353      +44

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@harshit-gangal
Copy link
Member

I believe, the new RPCs can be skipped from the documentation.

@GuptaManan100 GuptaManan100 marked this pull request as ready for review November 26, 2024 08:47
@GuptaManan100
docs: add changes to RPC segment
d90163e 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@GuptaManan100
Merge remote-tracking branch 'upstream/release-21.0' into rpc-changes
b52aaa0 
Signed-off-by: Manan Gupta <manan@planetscale.com>
@rohit-nayak-ps rohit-nayak-ps merged commit 8eb5ac8 into vitessio:release-21.0 Dec 2, 2024
96 checks passed
@rohit-nayak-ps rohit-nayak-ps deleted the rpc-changes branch December 2, 2024 14:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rohit-nayak-ps rohit-nayak-ps rohit-nayak-ps approved these changes

@shlomi-noach shlomi-noach shlomi-noach approved these changes

@deepthi deepthi Awaiting requested review from deepthi deepthi is a code owner

@harshit-gangal harshit-gangal Awaiting requested review from harshit-gangal

@mattlord mattlord Awaiting requested review from mattlord

@ajm188 ajm188 Awaiting requested review from ajm188

@notfelineit notfelineit Awaiting requested review from notfelineit

@frouioui frouioui Awaiting requested review from frouioui

@derekperkins derekperkins Awaiting requested review from derekperkins

@systay systay Awaiting requested review from systay

@timvaillancourt timvaillancourt Awaiting requested review from timvaillancourt

@arthurschreiber arthurschreiber Awaiting requested review from arthurschreiber

@vmg vmg Awaiting requested review from vmg

Assignees
No one assigned
Labels
Component: Documentation docs related issues/PRs Type: Documentation
Projects
None yet
Milestone
v21.0.1
Development

Successfully merging this pull request may close these issues.
5 participants
@GuptaManan100 @rohit-nayak-ps @harshit-gangal @shlomi-noach @vitess-bot